<?php

// some common types
function string() {}
function integer() {}

// ---------------
// the doc follows

/*! \mainpage rpd Framework

\section intro_sec Introduction

Thank you for using rpd Framework.

\section content Related Pages
 - \subpage Installation
 - \subpage first_steps
 - \subpage folders
 - \subpage hook
 - \subpage additional
*/

// -----------------------------------------------------------------------------

/*! \page Installation

\section install_sec Installation
\subsection step1 Step 1: Download your copy of rpd

Visit http://code.google.com/p/rpd/downloads and download the latest version
of rpd.

\subsection step2 Step 2: Upload rpd

Connect to your FTP and upload the whole files where you want.

\subsection step3 Step 3: Done

Thank you for using rpd Framework. We hope you enjoy it an write new
applications faster than ever.
 */

// -----------------------------------------------------------------------------

/*! \page first_steps First steps
 *
\section first_steps First steps
MVC

\page folders Structure of folders
\section folders Structure of folders

- app
  - Model (used for MVC)
    - define new models for getting data here
  - View (used for MVC)
    - define the design for new sites here, where index.php goes as first page
  - Controler (used for MVC)
    - define the action for new sites here
- Hook (collects different additions)
  - Config (configure rpd here)
  - Plugin (add plugins here)
- rpd (the framework itself)
 */

// -----------------------------------------------------------------------------

/*! \page hook Hook (Additional files)

\section intro Introduction

The Hook is ment to manipulate the given framework for implementing new
plugins or configure the system.

\section Properties

\subsection config $config - the main configuration

\subsection rpd $rpd - exchange classes

If you want to replace the current used classes (e.g. "View" or "Db") with
another one defined in a different php for example just go like this:

@code
// replacing View
Hook::$rpd["View"] = "Hook/plugins/My_View_Plugin/View.php";

// replacing Db
Hook::$rpd["Db"] = "Hook/plugins/Path_to_it/The_Filename.php";
@endcode

If you want to add a class please use plugins.

\subsection plugin $plugin - import plugins

Plugins will be executed at the beginning of the system before anything
happens.

*/

// -----------------------------------------------------------------------------

/*! \page additional Additional information

Here are some useful information for developers:
- <a href="../uml/rpd.pdf">Overview of common Classes and Packages</a>

*/

?>